<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">

<head>

<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="STYLESHEET" href="../../book.css" charset="ISO-8859-1" type="text/css">
<title>About.ini File Format</title>
</head>

<body>

<h1>About.ini File Format</h1>
<p>Last revised March 25, 2003 for Eclipse 2.1</p>
<p>A feature's &quot;about&quot; information is given by properties in the
&quot;<code>about.ini</code>&quot; file located within the feature's <i>plug-in</i>.
This is a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Properties.html">java.util.Properties</a>
format file (ISO 8859-1 character encoding with \u<i>xxxx </i>Unicode escapes),
with the following keys:</p>
<ul>
  <li>&quot;<code>aboutText</code>&quot; - A multi-line text description of the
    feature containing copyright, license terms, license registration info, etc.
    URLs found in text are presented as links. Line breaks are indicated by
    &quot;<code>\n</code>&quot;; lines should be no longer than 75 characters
    each, and there is a limit of 15 lines. This information is shown in the
    main &quot;about&quot; dialog (used in conjunction with a half-sized image),
    and on the secondary &quot;about&quot; dialog describing individuals
    feature. All features are required to have this property.</li>
  <li>&quot;<code>windowImage</code>&quot; - A 16x16 pixel color image used to
    brand windows created by a product. The value of this property is a
    plug-in-relative path to an image file. This property is only required for
    primary features; other features may omit it.</li>
  <li>&quot;<code>featureImage</code>&quot; - A 32x32 pixel color image used as
    an icon for this feature. The value of this property is a plug-in-relative
    path to an image file. This image is shown on the &quot;about&quot; dialog
    describing individual features, and is also used on the main
    &quot;about&quot; dialog to indicate that the feature is present. This
    property is optional. Related features supplied by a single provider should
    contain copies of the identical image file; this allows duplicate images to
    be eliminated.</li>
  <li>&quot;<code>aboutImage</code>&quot; - A large color image that appears in
    the main &quot;about&quot; dialog for a product. The value of this property
    is a plug-in-relative path to an image file. This property is only required
    for primary features; other features should omit it. Both graphic-and-text,
    and graphic only layouts are supported, depending on the size of image
    provided. A half-size image of up to 250 pixels wide by 330 pixels high is
    shown on the main &quot;about&quot; dialog with text (&quot;<code>aboutText</code>&quot;
    property) beside it. A full-size image of up to 500 pixels wide by 330
    pixels high is shown without text.</li>
  <li>&quot;<code>welcomePage</code>&quot;&nbsp; - A welcome page. The value of
    this property is a plug-in-relative path to an XML-format file containing
    the feature's welcome page. This property is recommended for all major
    features; other features may omit it.</li>
  <li>&quot;<code>welcomePerspective</code>&quot;&nbsp; - The preferred
    perspective in which to show the welcome page. The value of this property is
    a workbench perspective id. This property is recommended for features with
    welcome pages that show better in the context of the feature's views and
    editors. Features that do not have welcome pages, or have no strong opinion
    where the welcome pages is shown, should omit it.</li>
  <li>&quot;<code>appName</code>&quot; - A short, non-translatable string used to associate a name
    with the application on platforms where this makes sense. In operating
    environments with the Motif window system, the value is used for Motif
    resource lookup (see xrdb and related). In addition, on the CDE window
    manager (used on Solaris and AIX), this is the name which shows up under the
    icon for windows which are minimized to the desktop. This property is
    required for primary features; other features may omit it.</li>
  <li>&quot;<code>tipsAndTricksHref</code>&quot;&nbsp; - Tips and tricks section
    of help documentation. The value of this property is a reference to a help
    book containing the feature's tips and trick section; for example, <code>tipsAndTricksHref=/org.eclipse.jdt.doc.user/tips/jdt_tips.html</code>.
    This property is recommended for all major features; other features may omit
    it.</li>
</ul>


</body>

</html>
